<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     * <a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     * <a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.lang3.text.translate;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.io.IOException;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.StringWriter;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.io.Writer;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.Locale;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    /**<a name="line.24"></a>
<FONT color="green">025</FONT>     * An API for translating text. <a name="line.25"></a>
<FONT color="green">026</FONT>     * Its core use is to escape and unescape text. Because escaping and unescaping <a name="line.26"></a>
<FONT color="green">027</FONT>     * is completely contextual, the API does not present two separate signatures.<a name="line.27"></a>
<FONT color="green">028</FONT>     * <a name="line.28"></a>
<FONT color="green">029</FONT>     * @since 3.0<a name="line.29"></a>
<FONT color="green">030</FONT>     * @version $Id: CharSequenceTranslator.java 1146844 2011-07-14 18:49:51Z mbenson $<a name="line.30"></a>
<FONT color="green">031</FONT>     */<a name="line.31"></a>
<FONT color="green">032</FONT>    public abstract class CharSequenceTranslator {<a name="line.32"></a>
<FONT color="green">033</FONT>    <a name="line.33"></a>
<FONT color="green">034</FONT>        /**<a name="line.34"></a>
<FONT color="green">035</FONT>         * Translate a set of codepoints, represented by an int index into a CharSequence, <a name="line.35"></a>
<FONT color="green">036</FONT>         * into another set of codepoints. The number of codepoints consumed must be returned, <a name="line.36"></a>
<FONT color="green">037</FONT>         * and the only IOExceptions thrown must be from interacting with the Writer so that <a name="line.37"></a>
<FONT color="green">038</FONT>         * the top level API may reliable ignore StringWriter IOExceptions. <a name="line.38"></a>
<FONT color="green">039</FONT>         *<a name="line.39"></a>
<FONT color="green">040</FONT>         * @param input CharSequence that is being translated<a name="line.40"></a>
<FONT color="green">041</FONT>         * @param index int representing the current point of translation<a name="line.41"></a>
<FONT color="green">042</FONT>         * @param out Writer to translate the text to<a name="line.42"></a>
<FONT color="green">043</FONT>         * @return int count of codepoints consumed<a name="line.43"></a>
<FONT color="green">044</FONT>         * @throws IOException if and only if the Writer produces an IOException<a name="line.44"></a>
<FONT color="green">045</FONT>         */<a name="line.45"></a>
<FONT color="green">046</FONT>        public abstract int translate(CharSequence input, int index, Writer out) throws IOException;<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>        /**<a name="line.48"></a>
<FONT color="green">049</FONT>         * Helper for non-Writer usage. <a name="line.49"></a>
<FONT color="green">050</FONT>         * @param input CharSequence to be translated<a name="line.50"></a>
<FONT color="green">051</FONT>         * @return String output of translation<a name="line.51"></a>
<FONT color="green">052</FONT>         */<a name="line.52"></a>
<FONT color="green">053</FONT>        public final String translate(CharSequence input) {<a name="line.53"></a>
<FONT color="green">054</FONT>            if (input == null) {<a name="line.54"></a>
<FONT color="green">055</FONT>                return null;<a name="line.55"></a>
<FONT color="green">056</FONT>            }<a name="line.56"></a>
<FONT color="green">057</FONT>            try {<a name="line.57"></a>
<FONT color="green">058</FONT>                StringWriter writer = new StringWriter(input.length() * 2);<a name="line.58"></a>
<FONT color="green">059</FONT>                translate(input, writer);<a name="line.59"></a>
<FONT color="green">060</FONT>                return writer.toString();<a name="line.60"></a>
<FONT color="green">061</FONT>            } catch (IOException ioe) {<a name="line.61"></a>
<FONT color="green">062</FONT>                // this should never ever happen while writing to a StringWriter<a name="line.62"></a>
<FONT color="green">063</FONT>                throw new RuntimeException(ioe);<a name="line.63"></a>
<FONT color="green">064</FONT>            }<a name="line.64"></a>
<FONT color="green">065</FONT>        }<a name="line.65"></a>
<FONT color="green">066</FONT>    <a name="line.66"></a>
<FONT color="green">067</FONT>        /**<a name="line.67"></a>
<FONT color="green">068</FONT>         * Translate an input onto a Writer. This is intentionally final as its algorithm is <a name="line.68"></a>
<FONT color="green">069</FONT>         * tightly coupled with the abstract method of this class. <a name="line.69"></a>
<FONT color="green">070</FONT>         *<a name="line.70"></a>
<FONT color="green">071</FONT>         * @param input CharSequence that is being translated<a name="line.71"></a>
<FONT color="green">072</FONT>         * @param out Writer to translate the text to<a name="line.72"></a>
<FONT color="green">073</FONT>         * @throws IOException if and only if the Writer produces an IOException<a name="line.73"></a>
<FONT color="green">074</FONT>         */<a name="line.74"></a>
<FONT color="green">075</FONT>        public final void translate(CharSequence input, Writer out) throws IOException {<a name="line.75"></a>
<FONT color="green">076</FONT>            if (out == null) {<a name="line.76"></a>
<FONT color="green">077</FONT>                throw new IllegalArgumentException("The Writer must not be null");<a name="line.77"></a>
<FONT color="green">078</FONT>            }<a name="line.78"></a>
<FONT color="green">079</FONT>            if (input == null) {<a name="line.79"></a>
<FONT color="green">080</FONT>                return;<a name="line.80"></a>
<FONT color="green">081</FONT>            }<a name="line.81"></a>
<FONT color="green">082</FONT>            int pos = 0;<a name="line.82"></a>
<FONT color="green">083</FONT>            int len = input.length();<a name="line.83"></a>
<FONT color="green">084</FONT>            while (pos &lt; len) {<a name="line.84"></a>
<FONT color="green">085</FONT>                int consumed = translate(input, pos, out);<a name="line.85"></a>
<FONT color="green">086</FONT>                if (consumed == 0) {<a name="line.86"></a>
<FONT color="green">087</FONT>                    char[] c = Character.toChars(Character.codePointAt(input, pos));<a name="line.87"></a>
<FONT color="green">088</FONT>                    out.write(c);<a name="line.88"></a>
<FONT color="green">089</FONT>                    pos+= c.length;<a name="line.89"></a>
<FONT color="green">090</FONT>                    continue;<a name="line.90"></a>
<FONT color="green">091</FONT>                }<a name="line.91"></a>
<FONT color="green">092</FONT>    //          // contract with translators is that they have to understand codepoints <a name="line.92"></a>
<FONT color="green">093</FONT>    //          // and they just took care of a surrogate pair<a name="line.93"></a>
<FONT color="green">094</FONT>                for (int pt = 0; pt &lt; consumed; pt++) {<a name="line.94"></a>
<FONT color="green">095</FONT>                    pos += Character.charCount(Character.codePointAt(input, pos));<a name="line.95"></a>
<FONT color="green">096</FONT>                }<a name="line.96"></a>
<FONT color="green">097</FONT>            }<a name="line.97"></a>
<FONT color="green">098</FONT>        }<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>        /**<a name="line.100"></a>
<FONT color="green">101</FONT>         * Helper method to create a merger of this translator with another set of <a name="line.101"></a>
<FONT color="green">102</FONT>         * translators. Useful in customizing the standard functionality.<a name="line.102"></a>
<FONT color="green">103</FONT>         *<a name="line.103"></a>
<FONT color="green">104</FONT>         * @param translators CharSequenceTranslator array of translators to merge with this one<a name="line.104"></a>
<FONT color="green">105</FONT>         * @return CharSequenceTranslator merging this translator with the others<a name="line.105"></a>
<FONT color="green">106</FONT>         */<a name="line.106"></a>
<FONT color="green">107</FONT>        public final CharSequenceTranslator with(CharSequenceTranslator... translators) {<a name="line.107"></a>
<FONT color="green">108</FONT>            CharSequenceTranslator[] newArray = new CharSequenceTranslator[translators.length + 1];<a name="line.108"></a>
<FONT color="green">109</FONT>            newArray[0] = this;<a name="line.109"></a>
<FONT color="green">110</FONT>            System.arraycopy(translators, 0, newArray, 1, translators.length);<a name="line.110"></a>
<FONT color="green">111</FONT>            return new AggregateTranslator(newArray);<a name="line.111"></a>
<FONT color="green">112</FONT>        }<a name="line.112"></a>
<FONT color="green">113</FONT>    <a name="line.113"></a>
<FONT color="green">114</FONT>        /**<a name="line.114"></a>
<FONT color="green">115</FONT>         * &lt;p&gt;Returns an upper case hexadecimal &lt;code&gt;String&lt;/code&gt; for the given<a name="line.115"></a>
<FONT color="green">116</FONT>         * character.&lt;/p&gt;<a name="line.116"></a>
<FONT color="green">117</FONT>         *<a name="line.117"></a>
<FONT color="green">118</FONT>         * @param codepoint The codepoint to convert.<a name="line.118"></a>
<FONT color="green">119</FONT>         * @return An upper case hexadecimal &lt;code&gt;String&lt;/code&gt;<a name="line.119"></a>
<FONT color="green">120</FONT>         */<a name="line.120"></a>
<FONT color="green">121</FONT>        public static String hex(int codepoint) {<a name="line.121"></a>
<FONT color="green">122</FONT>            return Integer.toHexString(codepoint).toUpperCase(Locale.ENGLISH);<a name="line.122"></a>
<FONT color="green">123</FONT>        }<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>    }<a name="line.125"></a>




























































</PRE>
</BODY>
</HTML>
